BBS Toolkit

home *** CD-ROM | disk | FTP | other *** search

/ BBS Toolkit / BBS Toolkit.iso / spitfire / sf_31.zip / SFSYSTEM.ZIP / SFSYSTEM.DOC next >

Wrap

Text File | 1991-06-24 | 25KB | 576 lines

SFSYSTEM.EXE Version 1.1 Written by Mike Woltz Buffalo Creek Software INTRODUCTION ------------ SFSYSTEM.EXE is a companion utility for SPITFIRE Bulletin Board System software and will allow a number of system configuration options to be set outside the SPITFIRE program. Using SFSYSTEM.EXE's command line parameters, a number of options can now be toggled on or off and values can be changed thru a scheduled event. SFSYSTEM.EXE must reside in your SPITFIRE WORK directory where your SFSYSTEM.DAT exists. If SFSYSTEM.DAT is not found, SFSYSTEM.EXE provides you with the option of creating it. MENU DRIVEN USAGE ----------------- When SFSYSTEM.EXE is executed from the DOS prompt without any of its optional command line parameters, a menu is displayed to the user showing the available options. The menu will look like this: >>>>>>>> MAIN MENU <<<<<<<< <D>... Display Command Line Usage <N>... Numeric Values <S>... Sysop Data <T>... Toggle Switches <Q>... Quit ENTER COMMAND - [D N S T Q]? After making a selection, except Q to Quit, a window will open up on the screen which displays all the features which can be modified for the option you have selected. As each window opens, the current setting will be shown to you for each feature. Pressing the ESC key will always return to the previous screen. Pressing Q will terminate program execution and you will be returned to the DOS prompt. DISPLAY COMMAND LINE USAGE -------------------------- When this option is selected a window will open up displaying the following command line usage parameters available with SFSYSTEM: /D[x] = Downloads Per Day...................[x] = Number Of Downloads /L[x] = Log On Time Limit...................[x] = Number Of Minutes /O[x] = Daily Log On Limit..................[x] = Amount Of Log Ons /R[x] = Upload/Download Ratio...............[x] = Transfer Ratio /T[x] = Daily Time Limit....................[x] = Number Of Minutes /V[x] = U/D Ratio Violation Security........[x] = Altered Security Level /B- = NU Birthdate Not Required /B+ = NU Birthdate Required /P- = NU Default Procotol Off /P+ = NU Default Procotol On /S- = Scan Queued Msg Conferences Only /S+ = Scan All Msg Conferences These options can be used as command line parameters for toggling the selected features ON and OFF via SPITFIRE's scheduled events. More detailed information on how this is accomplished is discussed in the section, Usage As A Scheduled Event. TOGGLE SWITCHES --------------- Selecting Toggle Switches will enable the Sysop to toggle the following SPITFIRE features: <A> U.S. Phone Format This allows the Sysop to set whether the BBS will use a US phone number format (###-###-####) or allow for SPITFIRE to merely accept any 12 character string entered by the user. The SPITFIRE default is set for the US Phone Number Style. Convert File Description This feature allows the Sysop to toggle SPITFIRE's File Description Conversion On and Off. When this is toggled On, SPITFIRE will automatically convert the first character of each word in the file description to uppercase. All other characters will be lower case. If this feature is toggled Off, SPITFIRE makes no attempt to alter the description entered by the caller. SPITFIRE, by default, sets this feature On. <C> Net Mail Message Base This toggle allows the Sysop to configure their BBS to allow Net Mail Messages. If this is toggled to Yes, a user may enter messages to others who are not a users on the BBS. If this is toggled to No, messages can only be sent to other users of the BBS. This also applies to Carbon Copy messages. <D> Multi-node System This option allows you to toggle whether you wish to configure your BBS as a multi-node system. If you are operating more than one node, you will want to toggle this to Yes and if you are operating a single node system, you will want to toggle this to No. <E> New User Default Protocol This feature is used to determine if a new user logging on the BBS can select a default file transfer protocol after completing the new user questionnaire. If this is toggled to Yes, the new user will be presented with this option. If this feature is set Off, the new user will not automatically be presented with this option, but may still select a default file transfer protocol from the <Y>...Your Statistics option of the Main Menu. <F> Require New User Birthdate This feature allows the Sysop to designate whether a new user logging onto the BBS for the first time will be required to enter their birthdate. If toggled to Yes, the birthdate will be required and if toggled to No, the user will not be prompted to enter their birthdate. **NOTE** SPITFIRE uses a caller's birthdate as the second password, when required. It is not possible to require a second password if the BBS does not require the caller to enter their birthdate. Therefore, the SPITFIRE Second Password feature will not be operative if the New User Birthdate requirement is turn off. <G> Scan All Msg Conferences This feature allows the Sysop to designate the message scan parameters. When set to Yes, all message conferences are included in the scan. When set to No, only messages in the caller's queued conferences are scanned. This affects both the log-on message scan and the scan done by selecting <Y>...Your Message option from the Message Menu. <H> Comprehensive Upload Search This feature allows the Sysop to configure SPITFIRE to perform a comprehensive file search prior to a caller performing an upload. When this feature is turned SPITFIRE will trim all numeric characters from the end of the file name and compare that file name against all existing file names by trimming the numeric characters from those file names. For example, if the caller told SPITFIRE that DSZ0691.ZIP was going to be uploaded then SPITFIRE would then trim the '0691' from the file and search for DSZ*.*. Now let's say that SPITFIRE finds DSZ0591.ZIP on the drive. The caller would be advised that DSZ0591.ZIP already exists and then asked if DSZ0691.ZIP is still to be uploaded. When this feature is turned off, then SPITFIRE searches only for the exact file name. NUMERIC VALUES -------------- This option will allow modification to be made to any of the following numerical values: <A> Caller Number This gives you the opportunity to set the number of callers. The reason for this is if you are already running an established board, you can enter the the current number of callers, so as not to start the BBS with Caller Number 1. Number Of Calls Today This sets the limit of how many times a user can call your board per day. If this amount is exceeded, the system will display TOOMANY.BBS and log the user off. <C> Messages Today This option is used to set the total number of messages left on your BBS for the current day. <D> Uploads Today This option is used to set the total number of files uploaded to your BBS for the current day. <E> Downloads Today This option is used to set the total number of files downloaded from your BBS for the current day. <F> Daily Time Limit Sets the amount of time per day, per user. <G> Daily Log On Limit Sets the amount of time per call, per user. <H> Log On Time Limit Sets the amount of time per day a user is allowed on the board. New User Security Allows you to set the default security level for a new user. <J> New User 1st Day Time Allows you to set the amount of time on the board for the new user's visit. (First day only) <K> Download Limit Per Day This option can be used to set the total number of files you will allow a user on your system to download each day. NOTE: Any parameters set in DAILYLMT.DAT will supercede those set here. <L> Download/Upload Ratio Sets the ratio of downloads to uploads. (i.e. - If a user uploads 1 file and downloads x amount of files that exceeds the "x" amount, then after the download is completed, SPITFIRE sends SFRATIO.BBS unless DAILYLMT.DAT instructs SPITFIRE not to). SFRATIO.BBS is normally written to notify the users that their upload/download ratio is unacceptable. <M> Maximum Amount Of Users Determines the amount of users you will allow to utilize your BBS. (i.e. - If you have this value set at 500 and you already have 500 users and a new user (501) tries to log on, the system displays the file MAXUSERS.BBS and logs the user off.) <N> Number Of Nodes This option allows you to set the number of nodes operating on your SPITFIRE BBS System. <O> No Keystroke Time Limit This option sets the time in minutes that a caller is allowed to elapse without entering any keystrokes on the BBS. Once this time has passed, the caller will automatically be logged off. If available, SFASLEEP.BBS/CLR will be displayed to the caller prior to the automatic log off. U/D Ratio Violation Security This specifies the security level that a caller will be changed to if the upload/download ratio is violated and the following conditions are met: 1) The caller has exceeded the upload/download ratio of 1 upload to the configured Upload/Download Ratio plus 6. SPITFIRE adds the additional amount to ensure SFRATIO.BBS/CLR will be displayed to warn the caller of the possible change in status. 2) The caller's security level in the DAILYLMT.DAT file is set to display SFRATIO.BBS/CLR when the upload/download ratio is violated 3) The SPITFIRE Enforce Up/Download ratio is toggled to Yes. **NOTE** SPITFIRE will return the caller to their original security once the caller's upload/download ratio is again within the required ratio limits and provided: 1) The Enforce Up/Download Ratio switch is toggled On. 2) The caller's security level matches the U/D Ratio Violation Security. SYSOP DATA ---------- <A> Sysop's Name Allows you to change the name of the System Operator of the BBS. This is the name callers will see credited as the Sysop when first logging onto a SPITFIRE Bulletin Board System. In most incidences, you will want to use your real name here. Sysop User Name This option will allow you to change the Sysop User Name. Standard practice usually dictates that the "Sysop" be used as the Sysop User Name. If any other name is used, callers will be unable to use the Comment To Sysop option from the Main Menu. <C> Drop To DOS Password Sets the password that is needed to drop to DOS from a remote location. The default is "Spitfire", but you will wish to change this for the sake of security. <D> BBS Starting Date This provides an opportunity to set the starting date of your bulletin board. The reason for this is if you are already running an established board, you can enter the original starting date of your BBS rather than the date of your conversion to SPITFIRE. <E> Sysop Security Level This allows you to set the security setting for users you will grant Sysop status. Callers with a security equal to or greater than the Sysop Security Level have certain privileges not available to most users. For example, a user with Sysop status can ..Undelete deleted messages. Refer to the SPITFIRE manual section - Special Commands For Sysop Status - for a more detailed explanation of Sysop status. USAGE AS A SCHEDULED EVENT -------------------------- The inclusion of the command line usage parameters provide some unique opportunities in the configuration of your SPITFIRE BBS. A brief description of each follows. /D[x] = Downloads Per Day..................[x] = Number Of Downloads The /D[x] allows you to configure the number of files you will allow callers to download from your BBS each day. For instance, if you wish to set the limit to 10, you would use /D10. If a caller attempts to exceed the number of downloads you have configured, DLMT.BBS/CLR will be displayed if available. /L[x] = Log On Time Limit..................[x] = Number Of Minutes The /L[x] allows you to configure the maximum number of minutes a caller to your BBS is permitted for each log on. For instance, if you wish to set the limit to 60, you would use /L60. If a caller exceeds this, SFTIMEUP.BBS/CLR will be displayed to the caller and the caller will be logged off the BBS. /O[x] = Daily Log On Limit.................[x] = Amount Of Log Ons The /O[x] allows you to configure the amount of times you will allow callers to access your system each day. For instance, if you wish to limit the number of times a caller can log on your BBS to 5 times per day, you would use /O5. If a caller attempts to exceed the number of allowable daily log ons you have configured, TOOMANY.BBS/CLR will be displayed, if available, and the caller will be logged off. /R[x] = Upload/Download Ratio..............[x] = Transfer Ratio The /R[x] allows you to configure the required upload-download ratio you wish to establish for your BBS. For instance, if you wish to set a ratio requirement of 1 upload for every 10 downloads, you would use /R10. If a caller's download ratio exceeds your configured ratio, SFRATIO.BBS/CLR, if available, will be displayed to the caller. /T[x] = Daily Time Limit...................[x] = Number Of Minutes The /R[x] allows you to configure the total number of minutes a caller will be permitted to use each day on your BBS. For instance, if you wish to set the total number of minutes allowed on your BBS each day to 90, you would use /T90. If a caller is logged on the BBS and exceeds their allotted daily time limit, SFTIMEUP.BBS/CLR (if found) will be displayed to the caller and the caller will be logged off the BBS. If a caller attempts to log onto the BBS after exceeding the allowable daily time limit, SFNOTIME.BBS/CLR (if found) is displayed to the caller and the caller is denied access to the BBS. Previously you could only configure your BBS to allow a set log on time limit. With SFSYSTEM.EXE it is possible to allow, for instance, a 60 minute log on time limit during the less active hours of BBS activity and decrease this amount to 45 minutes when the board is at its busiest. This is one example of the possibilities now available using SFSYSTEM's command line parameters and SPITFIRE's scheduled events. /V[x] = U/D Ratio Violation Security........[x] = Altered Security Level This specifies the security level that a caller will be changed to if the upload/download ratio is violated and the following conditions are met: 1) The caller has exceeded the upload/download ratio of 1 upload to the configured Upload/Download Ratio plus 6. SPITFIRE adds the additional amount to ensure SFRATIO.BBS/CLR will be displayed to warn the caller of the possible change in status. 2) The caller's security level in the DAILYLMT.DAT file is set to display SFRATIO.BBS/CLR when the upload/download ratio is violated 3) The SPITFIRE Enforce Up/Download ratio is toggled to Yes. **NOTE** SPITFIRE will return the caller to their original security once the caller's upload/download ratio is again within the required ratio limits and provided: 1) The Enforce Up/Download Ratio switch is toggled On. 2) The caller's security level matches the U/D Ratio Violation Security. /B- = NU Birthdate Not Required /B+ = NU Birthdate Required The /B- configures your BBS so new users will not be required to to provide their birthdate while the /B+ parameter configures your BBS so new users will be required to provide their birthdate. The second password feature within SPITFIRE will not be operable when the birthdate is not required. /P- = NU Default Procotol Off /P+ = NU Default Procotol On The /P- configures your BBS so new users will not be given the opportunity to select a default file transfer protocol while the /P+ parameter configures your BBS so new users will be given the opportunity to select a default file transfer protocol. Regardless of this configuration, users will still be able to select a default protocol by using the <Y>our Statistics from the SPITFIRE Main Menu. /S- = Scan Queued Msg Conferences Only /S+ = Scan All Msg Conferences The /S- configures your BBS to scan only the user's queued message conferences when logging on your board and/or when using the <Y>our Messages feature from the Message Menu while the /S+ parameter configures your BBS to scan all message conferences. The procedure for using the command line parameters is the same for each of these options. The syntax for using the SFSYSTEM with the command line parameters is this to enter SFSYSTEM, a blank space and then the command line parameter you wish to use for configuring your system. For instance: SFSYSTEM /R10 (This would establish an upload-download ratio of 1 to 10) This documentation will take you through the steps of toggling the log on time limit from 60 to 45 minutes as a scheduled event. The remaining options can be set up using SPITFIRE's scheduled events in much the same way. To set up the log on time limit of 60 minutes as a scheduled event, you will need to select Create An Event from the Event's Menu (available at the SPITFIRE Ready For Use prompt by pressing ALT+E simultaneously or from the Sysop utilities menu). Next select A as the event to be created. You are then prompted for the time the event will be performed. Let's assume you will enter 01:00. Next, you are prompted for the day the event will be performed. Let's assume you wish to run the event daily, so enter 7. Following the same procedure a second event will need to be created to toggle the log on time limit to 45 minutes during the busiest hours of your BBS. Again, let's assume your BBS gets its busiest around 6 pm. Again, create an event using the Event's Menu, only this time select B as the event to be created. You are then prompted for the time the event will be performed. Enter 18:00. You will want this event to run daily also, so once again, when prompted for the day the event will be performed, enter 7. Now, using your favorite text editor, the SF.BAT file for Event A and Event B will look like this: :EVENT_A REM Place Event Commands Here GOTO LOOP :EVENT_B REM Place Event Commands Here GOTO LOOP What is required next is to include all necessary DOS commands which are needed to toggle the log on time limit from 45 to 60 minutes with the SFSYSTEM utility and enter those in place of the "REM Place Event Commands Here". A completed SF.BAT for Event A and Event B would appear as: :EVENT_A CD\SF\WORK SFSYSTEM /L60 CD\SF GOTO LOOP :EVENT_B CD\SF\WORK SFSYSTEM /L45 CD\SF GOTO LOOP With these events set up in the previously described manner, every morning at 1:00 am, EVENT_A will execute SFSYSTEM to modify your SPITFIRE BBS configuration to allow a log on time limit of 60 minutes. Then each evening at 6:00 pm, EVENT-B will execute SFSYSTEM to modify your BBS configuration to reduce the log on time limit to 45 minutes. IMPORTANT NOTE -------------- SFSYSTEM should NOT be executed by jumping to DOS and modifying parameters will SPITFIRE is in memory. SPITFIRE holds the established settings in memory so before the changes can be effective, SPITFIRE must be re-booted. You MUST exit out of SPITFIRE by pressing F10 or the changes you make will not be effective. DISTRIBUTION ------------ SFSYSTEM is distributed under the shareware concept. You are free to distribute the SFSYSTEM program as long as it remains unmodified and no fee is charged. If you use this program and find it beneficial a fee is required. A $1.00 fee is required of registered SPITFIRE sysops and a $5.00 fee is required of all others. This registration should be mailed to the below listed address. BUFFALO CREEK SOFTWARE ATTN: Mike Woltz 913 - 39th Street West Des Moines, Iowa 50265 DISCLAIMER ---------- Mike Woltz and/or Buffalo Creek Software shall in no way be held responsible for any damage incurred while operating SPITFIRE. All responsibility lies with the user of the software. The documentation for SFSYSTEM is contributed by Jacque Shipley and The Mother Board BBS. The shareware version of SPITFIRE and other SPITFIRE utilities are available for download from: Buffalo Creek's BBS The Mother Board BBS Mike Woltz, Sysop Jacque Shipley, Sysop (515) 225-8496 (515) 986-3464 38400/19200/9600/2400/1200 Baud 19200/9600/2400/1200 Baud